feat(remark-lint): improve validation#8746
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
👋 Codeowner Review RequestThe following codeowners have been identified for the changed files: Team reviewers: @nodejs/nodejs-website @nodejs/web-infra Please review the changes when you have a chance. Thank you! 🙏 |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #8746 +/- ##
==========================================
+ Coverage 75.11% 75.27% +0.15%
==========================================
Files 104 105 +1
Lines 9167 9242 +75
Branches 315 326 +11
==========================================
+ Hits 6886 6957 +71
- Misses 2279 2283 +4
Partials 2 2 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Pull request overview
This PR enhances the @node-core/remark-lint API-doc preset to validate deprecation entries and to recognize/normalize type references inside link text.
Changes:
- Add a new
node-core:invalid-deprecationsrule (and unit tests) to validate ordering and required metadata blocks in deprecation docs. - Update
node-core:invalid-type-referenceto detect type references viaQUERIES.normalizeTypes, including cases like[<Type>](). - Bump
@node-core/doc-kitdependency (and lockfile) and bump@node-core/remark-lintversion to1.3.0.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| pnpm-lock.yaml | Updates lockfile for @node-core/doc-kit@1.0.2 and related dependency graph changes. |
| packages/remark-lint/src/rules/invalid-type-reference.mjs | Adjusts type-reference detection and normalization logic to work in more AST contexts (e.g., link text). |
| packages/remark-lint/src/rules/invalid-deprecations.mjs | Introduces a new rule to validate deprecation codes ordering and presence of required sections. |
| packages/remark-lint/src/rules/tests/invalid-type-reference.test.mjs | Adds coverage for miswrapped type references inside link text. |
| packages/remark-lint/src/rules/tests/invalid-deprecations.test.mjs | Adds unit tests for ordering/type/changes validation in deprecations content. |
| packages/remark-lint/src/api.mjs | Registers the new invalid-deprecations rule in the API preset. |
| packages/remark-lint/package.json | Bumps package version and @node-core/doc-kit dependency range. |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
📦 Build Size ComparisonSummary
Changes➕ Added Assets (1)
➖ Removed Assets (1)
|
ovflowd
left a comment
ovflowd
left a comment
There was a problem hiding this comment.
Ultimately, fine with the PR. Just wondering if it could be documented a bit more, like here type[0] !== '{' || type[type.length - 1] !== '}' you documented it of sorts but on the lines below not much.
Co-Authored-By: Caner Akdas <canerakdas@gmail.com> Signed-off-by: Aviv Keller <me@aviv.sh>
avivkeller
force-pushed
the
feat/remark-lint
branch
from
9e8a728 to
5061a27
Compare
Ref: nodejs/node#62090
Adds deprecation validation based on https://github.com/nodejs/node/blob/main/tools/doc/deprecationCodes.mjs, and allows type validation to work in links (i.e.
[<Type>]())